<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>get ratios of each site's scores to US means (using output of batch buffering) — calc_ratios_to_avg • EJAM</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="get ratios of each site's scores to US means (using output of batch buffering) — calc_ratios_to_avg"><meta name="description" content="Used to create input to boxplots_ratios() and can be used elsewhere now"><meta property="og:description" content="Used to create input to boxplots_ratios() and can be used elsewhere now"><meta property="og:image" content="https://usepa.github.io/EJAM/logo.svg"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">EJAM</a>

    <small class="nav-text text-warning me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">2.32.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Overview for EJAM Users</h6></li>
    <li><a class="dropdown-item" href="../articles/0_whatis.html">What is EJAM</a></li>
    <li><a class="dropdown-item" href="../articles/0_webapp.html">Using EJAM</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>For analysts using R</h6></li>
    <li><a class="dropdown-item" href="../articles/1_installing.html">Installing the EJAM R package</a></li>
    <li><a class="dropdown-item" href="../articles/2_quickstart.html">Quick Start Guide</a></li>
    <li><a class="dropdown-item" href="../articles/3_analyzing.html">Basics of Using EJAM for Analysis in RStudio</a></li>
    <li><a class="dropdown-item" href="../articles/4_advanced.html">Advanced Features</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/USEPA/EJAM/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.svg" class="logo" alt=""><h1>get ratios of each site's scores to US means (using output of batch buffering)</h1>
      <small class="dont-index">Source: <a href="https://github.com/USEPA/EJAM/blob/HEAD/R/calc_ratios_to_avg.R" class="external-link"><code>R/calc_ratios_to_avg.R</code></a></small>
      <div class="d-none name"><code>calc_ratios_to_avg.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Used to create input to<code><a href="boxplots_ratios.html"> boxplots_ratios()</a></code> and can be used elsewhere now</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">calc_ratios_to_avg</span><span class="op">(</span></span>
<span>  <span class="va">out</span>,</span>
<span>  evarnames <span class="op">=</span> <span class="va">names_e</span>,</span>
<span>  dvarnames <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="va">names_d</span>, <span class="va">names_d_subgroups</span><span class="op">)</span>,</span>
<span>  zone.prefix <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">""</span>, <span class="st">"state."</span><span class="op">)</span><span class="op">[</span><span class="fl">1</span><span class="op">]</span>,</span>
<span>  avg.evarnames <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/paste.html" class="external-link">paste0</a></span><span class="op">(</span><span class="va">zone.prefix</span>, <span class="st">"avg."</span>, <span class="va">evarnames</span><span class="op">)</span>,</span>
<span>  avg.dvarnames <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/paste.html" class="external-link">paste0</a></span><span class="op">(</span><span class="va">zone.prefix</span>, <span class="st">"avg."</span>, <span class="va">dvarnames</span><span class="op">)</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-out">out<a class="anchor" aria-label="anchor" href="#arg-out"></a></dt>
<dd><p>data.frame output from <code><a href="ejscreenapi_plus.html">ejscreenapi_plus()</a></code> or from <code><a href="ejscreenapi.html">ejscreenapi()</a></code> or doaggregate(),
one row per buffer or site, and
columns for indicators named in evarnames, dvarnames, avg.evarnames, avg.dvarnames</p></dd>


<dt id="arg-evarnames">evarnames<a class="anchor" aria-label="anchor" href="#arg-evarnames"></a></dt>
<dd><p>vector of variable names for environmental indicators in out, like pm, o3, etc.</p></dd>


<dt id="arg-dvarnames">dvarnames<a class="anchor" aria-label="anchor" href="#arg-dvarnames"></a></dt>
<dd><p>vector of variable names for demographic indicators in out, such as pctlowinc</p></dd>


<dt id="arg-zone-prefix">zone.prefix<a class="anchor" aria-label="anchor" href="#arg-zone-prefix"></a></dt>
<dd><p>us or state, must fit with colnames in out such as  avg.pctlowinc and state.avg.pctlowinc</p></dd>


<dt id="arg-avg-evarnames">avg.evarnames<a class="anchor" aria-label="anchor" href="#arg-avg-evarnames"></a></dt>
<dd><p>use only if user-specific variable names are in out,
with defaults like avg.pm</p></dd>


<dt id="arg-avg-dvarnames">avg.dvarnames<a class="anchor" aria-label="anchor" href="#arg-avg-dvarnames"></a></dt>
<dd><p>use only if user-specific variable names are in out,
with defaults like  avg.pctlowinc</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>a list with ratios_d and ratios_e which are
vectors of numbers the lengths of dvarnames and evarnames</p>
    </div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p>Note that colnames returned are same as input, not renamed to say "ratio"
If names_d_subgroups are included, those means are not in API output from EJScreen
so it gets the means from usastats or statestats</p>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span> <span class="va">out</span> <span class="op">&lt;-</span> <span class="va">testoutput_ejscreenit_5</span><span class="op">$</span><span class="va">table</span> <span class="co"># has long names</span></span>
<span> <span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">out</span><span class="op">)</span> <span class="op">&lt;-</span> <span class="fu"><a href="fixcolnames.html">fixcolnames</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">out1</span><span class="op">)</span>,<span class="st">'long'</span>,<span class="st">'r'</span><span class="op">)</span></span>
<span> <span class="va">out2</span> <span class="op">&lt;-</span> <span class="va">testoutput_ejscreenapi_plus_5</span> <span class="co"># has r names already</span></span>
<span> </span>
<span> <span class="co"># these are data.frames, but the colnames are different:</span></span>
<span> <span class="co">#   names like "Demog.Index" but they are ratios</span></span>
<span> <span class="fu">calc_ratios_to_avg</span><span class="op">(</span><span class="va">out</span><span class="op">)</span><span class="op">$</span><span class="va">ratios_d</span></span>
<span> <span class="co">#   names like "ratio.to.avg.Demog.Index"</span></span>
<span> <span class="va">out</span><span class="op">[</span> , <span class="va">names_d_ratio_to_avg</span><span class="op">]</span> <span class="co"># needs EJAM for names_d_ratio_to_avg</span></span>
<span> </span>
<span> <span class="fu"><a href="boxplots_ratios.html">boxplots_ratios</a></span><span class="op">(</span><span class="fu">calc_ratios_to_avg</span><span class="op">(</span><span class="va">out</span><span class="op">)</span><span class="op">$</span><span class="va">ratios_d</span>,<span class="st">"pctlowinc"</span>,<span class="st">"% low income"</span>, </span>
<span>     wheretext<span class="op">=</span><span class="st">"Within a mile of"</span><span class="op">)</span></span>
<span>  </span></code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>US EPA 2024</p>
</div>

<div class="pkgdown-footer-right">
  <p>EJAM Version 2.32.0</p>
</div>

    </footer></div>





  </body></html>

